FHIR IG analytics| Package | hl7.fhir.uv.phr |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-FinancialReceipt.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/personal-health-record-format-ig/StructureDefinition-FinancialReceipt.html |
| URL | http://hl7.org/fhir/uv/phr/StructureDefinition/FinancialReceipt |
| Version | 1.0.0-ballot2 |
| Status | active |
| Date | 2026-07-09T21:10:21+00:00 |
| Name | FinancialReceipt |
| Title | Financial Receipt |
| Realm | uv |
| Authority | hl7 |
| Description | A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource. |
| Type | http://hl7.org/fhir/uv/phr/StructureDefinition/FinancialReceipt |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition FinancialReceipt
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  FinancialReceipt | 0..* | Base | Financial Receipt | |
  subject | 1..1 | Reference(Patient) | The patient or person that purchased the item | |
 date | 1..1 | dateTime | The date of the transaction | |
| vendor | 0..1 | string | Vendor or merchant name | |
 category | 0..1 | CodeableConcept | Category of expense (e.g. pharmacy, medical supply, copay, wellness) | |
| item | 0..* | BackboneElement | Line items on the receipt | |
 description | 1..1 | string | Item description | |
| quantity | 0..1 | SimpleQuantity | Quantity purchased | |
| unitPrice | 0..1 | Money | Price per unit | |
 amount | 0..1 | Money | Line item total | |
| subtotal | 0..1 | Money | Subtotal before tax | |
| taxAmount | 0..1 | Money | Tax amount | |
| total | 1..1 | Money | Total amount paid | |
| paymentMethod | 0..1 | CodeableConcept | Payment method (e.g. cash, credit, debit, HSA, FSA) | |
| relatedClaim | 0..1 | Reference(Claim) | Related insurance claim, if any | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "FinancialReceipt",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pe"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/phr/ImplementationGuide/hl7.fhir.uv.phr"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/phr/ImplementationGuide/hl7.fhir.uv.phr"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/phr/StructureDefinition/FinancialReceipt",
"version": "1.0.0-ballot2",
"name": "FinancialReceipt",
"title": "Financial Receipt",
"status": "active",
"date": "2026-07-09T21:10:21+00:00",
"publisher": "HL7 International / Patient Empowerment",
"contact": [
{
"name": "HL7 International / Patient Empowerment",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientempowerment"
}
]
}
],
"description": "A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/phr/StructureDefinition/FinancialReceipt",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "FinancialReceipt",
"path": "FinancialReceipt",
"short": "Financial Receipt",
"definition": "A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "FinancialReceipt.subject",
"path": "FinancialReceipt.subject",
"short": "The patient or person that purchased the item",
"definition": "The patient or person that purchased the item",
"min": 1,
"max": "1",
"base": {
"path": "FinancialReceipt.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "FinancialReceipt.date",
"path": "FinancialReceipt.date",
"short": "The date of the transaction",
"definition": "The date of the transaction",
"min": 1,
"max": "1",
"base": {
"path": "FinancialReceipt.date",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "FinancialReceipt.vendor",
"path": "FinancialReceipt.vendor",
"short": "Vendor or merchant name",
"definition": "Vendor or merchant name",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.vendor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "FinancialReceipt.category",
"path": "FinancialReceipt.category",
"short": "Category of expense (e.g. pharmacy, medical supply, copay, wellness)",
"definition": "Category of expense (e.g. pharmacy, medical supply, copay, wellness)",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.category",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FinancialReceipt.item",
"path": "FinancialReceipt.item",
"short": "Line items on the receipt",
"definition": "Line items on the receipt",
"min": 0,
"max": "*",
"base": {
"path": "FinancialReceipt.item",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FinancialReceipt.item.id",
"path": "FinancialReceipt.item.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FinancialReceipt.item.extension",
"path": "FinancialReceipt.item.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FinancialReceipt.item.modifierExtension",
"path": "FinancialReceipt.item.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FinancialReceipt.item.description",
"path": "FinancialReceipt.item.description",
"short": "Item description",
"definition": "Item description",
"min": 1,
"max": "1",
"base": {
"path": "FinancialReceipt.item.description",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "FinancialReceipt.item.quantity",
"path": "FinancialReceipt.item.quantity",
"short": "Quantity purchased",
"definition": "Quantity purchased",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.item.quantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "FinancialReceipt.item.unitPrice",
"path": "FinancialReceipt.item.unitPrice",
"short": "Price per unit",
"definition": "Price per unit",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.item.unitPrice",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.item.amount",
"path": "FinancialReceipt.item.amount",
"short": "Line item total",
"definition": "Line item total",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.item.amount",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.subtotal",
"path": "FinancialReceipt.subtotal",
"short": "Subtotal before tax",
"definition": "Subtotal before tax",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.subtotal",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.taxAmount",
"path": "FinancialReceipt.taxAmount",
"short": "Tax amount",
"definition": "Tax amount",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.taxAmount",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.total",
"path": "FinancialReceipt.total",
"short": "Total amount paid",
"definition": "Total amount paid",
"min": 1,
"max": "1",
"base": {
"path": "FinancialReceipt.total",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.paymentMethod",
"path": "FinancialReceipt.paymentMethod",
"short": "Payment method (e.g. cash, credit, debit, HSA, FSA)",
"definition": "Payment method (e.g. cash, credit, debit, HSA, FSA)",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.paymentMethod",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FinancialReceipt.relatedClaim",
"path": "FinancialReceipt.relatedClaim",
"short": "Related insurance claim, if any",
"definition": "Related insurance claim, if any",
"min": 0,
"max": "1",
"base": {
"path": "FinancialReceipt.relatedClaim",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Claim"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "FinancialReceipt",
"path": "FinancialReceipt",
"short": "Financial Receipt",
"definition": "A logical model for over-the-counter (OTC) health-related purchase receipts. Captures expenses for items such as pharmacy purchases, medical supplies, copays, and wellness products that may not generate a formal insurance Claim resource."
},
{
"id": "FinancialReceipt.subject",
"path": "FinancialReceipt.subject",
"short": "The patient or person that purchased the item",
"definition": "The patient or person that purchased the item",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "FinancialReceipt.date",
"path": "FinancialReceipt.date",
"short": "The date of the transaction",
"definition": "The date of the transaction",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "FinancialReceipt.vendor",
"path": "FinancialReceipt.vendor",
"short": "Vendor or merchant name",
"definition": "Vendor or merchant name",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "FinancialReceipt.category",
"path": "FinancialReceipt.category",
"short": "Category of expense (e.g. pharmacy, medical supply, copay, wellness)",
"definition": "Category of expense (e.g. pharmacy, medical supply, copay, wellness)",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FinancialReceipt.item",
"path": "FinancialReceipt.item",
"short": "Line items on the receipt",
"definition": "Line items on the receipt",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FinancialReceipt.item.description",
"path": "FinancialReceipt.item.description",
"short": "Item description",
"definition": "Item description",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "FinancialReceipt.item.quantity",
"path": "FinancialReceipt.item.quantity",
"short": "Quantity purchased",
"definition": "Quantity purchased",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "FinancialReceipt.item.unitPrice",
"path": "FinancialReceipt.item.unitPrice",
"short": "Price per unit",
"definition": "Price per unit",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.item.amount",
"path": "FinancialReceipt.item.amount",
"short": "Line item total",
"definition": "Line item total",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.subtotal",
"path": "FinancialReceipt.subtotal",
"short": "Subtotal before tax",
"definition": "Subtotal before tax",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.taxAmount",
"path": "FinancialReceipt.taxAmount",
"short": "Tax amount",
"definition": "Tax amount",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.total",
"path": "FinancialReceipt.total",
"short": "Total amount paid",
"definition": "Total amount paid",
"min": 1,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"id": "FinancialReceipt.paymentMethod",
"path": "FinancialReceipt.paymentMethod",
"short": "Payment method (e.g. cash, credit, debit, HSA, FSA)",
"definition": "Payment method (e.g. cash, credit, debit, HSA, FSA)",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FinancialReceipt.relatedClaim",
"path": "FinancialReceipt.relatedClaim",
"short": "Related insurance claim, if any",
"definition": "Related insurance claim, if any",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Claim"
]
}
]
}
]
}
}